Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add diagrams for the import and scanning component #154

Open
wants to merge 3 commits into
base: next
Choose a base branch
from

Conversation

namhoang1604
Copy link
Collaborator

@namhoang1604 namhoang1604 commented Nov 5, 2024

What type of PR is this? (check all applicable)

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation Update
  • 🎨 Style
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ”₯ Performance Improvements
  • βœ… Test
  • πŸ€– Build
  • πŸ” CI
  • πŸ“¦ Chore (Release)
  • ⏩ Revert

Description

This PR updates the diagram for the import and scanning component.

Related Tickets & Documents

https://github.com/gs-gs/fa-ag-trace/issues/667

Mobile & Desktop Screenshots/Recordings

image image

Added tests?

  • πŸ‘ yes
  • πŸ™… no, because they aren't needed
  • πŸ™‹ no, because I need help

Added to documentation?

  • πŸ“œ README.md
  • πŸ“• documentation
  • πŸ™… no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

Copy link

github-actions bot commented Nov 5, 2024

Code Coverage Report

Lines Statements Branches Functions
Coverage: 80%
79.89% (2773/3471) 65.58% (526/802) 73.97% (307/415)
Title Lines Statements Branches Functions
All packages Coverage: 80%
79.89% (2773/3471) 65.58% (526/802) 73.97% (307/415)
Components Coverage: 85%
84.85% (510/601) 73.75% (118/160) 77.04% (94/122)
Mock app Coverage: 69%
69.59% (357/513) 49.26% (67/136) 67.85% (76/112)
Services Coverage: 79%
77.05% (927/1203) 60.17% (210/349) 74.41% (96/129)
UNTP test suite Coverage: 57%
57.34% (992/1730) 80.86% (131/162) 71.92% (41/57)
VC test suite Coverage: 7%
7.4% (12/162) 7.4% (2/27)

participant MA as Mock App
participant V as VCKit

U->>MA: Import file
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@namhoang1604, what are the permitted data structures of the file being imported? What are the allowed file extensions? What are the permitted credential types?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @ashleythedeveloper, the data structure is defined here, they can be VC or JSON. There is a component render-check-list added examples for cases can happen.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ashleythedeveloper, I updated it for more details.

participant V as VCKit

U->>MA: Scan QRCode
MA->>MA: Fetch data from QRCode URL
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@namhoang1604, what are the permitted data structures of the QRpayload? Can we also use a Data Matrix? What are the permitted data structures of the file being fetched? What are the allowed file extensions? What are the permitted credential types? What happens if the contents of the credential being fetched are encrypted?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The data structure is defined here, it allows VC or JSON. The current implementation is not handling the encrypted data.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ashleythedeveloper, I updated it for more details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants